SoundComponentRemoveSource

SoundComponentRemoveSource
Header:	Sound.h		Carbon status:	Supported

Removes the existing sound source specified by the sourceID parameter.

ComponentResult SoundComponentRemoveSource (
    ComponentInstance ti, 
    SoundSource sourceID
);

Parameter descriptions

ti: A component instance that identifies your sound component.
sourceID: A source ID for the source component chain to be removed.

function result: Returns noErr if successful or an appropriate result code otherwise.

DISCUSSION

A sound output device component that implements the SoundComponentAddSource function must also implement the SoundComponentRemoveSource function to remove sound sources. Your SoundComponentRemoveSource function should do whatever is necessary to invalidate that source and then call through to the Apple Mixer’s SoundComponentRemoveSource function.

Most sound components do not need to implement the SoundComponentRemoveSource function. Only sound components that can handle more than one source of input need to define it.

SPECIAL CONSIDERATIONS

Your SoundComponentRemoveSource function is always called at noninterrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.